home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1995 October / EnigmA AMIGA RUN 01 (1995)(G.R. Edizioni)(IT)[!][issue 1995-10][Aminet 7].iso / Aminet / comm / mebbs / fst231.lha / fustick 2.31 / fustick.doc < prev    next >
Text File  |  1994-09-05  |  19KB  |  606 lines
  1. ****************************************************************************
  2. *                                                                          *
  3. * FUSTick 2.8 by Robert Wahlström    94-Mar-13                             *
  4. *                                                                          *
  5. * Copyright © by Robert Wahlström    All rights reserved.                  *
  6. *                                                                          *
  7. * Process and hatch .ticfiles                                              *
  8. *                                                                          *
  9. * Written in  SAS C 6.51   with CygnusED Pro & Chelp on Amiga 4000/040.    *
  10. *                                                                          *
  11. *  Robert Wahlström                                                        *
  12. *  Enehagsg 197                                                            *
  13. *  S-441 57  ALINGSÅS   SWEDEN                                             *
  14. *                                                                          *
  15. *  Usenet:   d0robert@dtek.chalmers.se                                     *
  16. *  Fidonet:  2:203/316.0                                                   *
  17. *  Amiganet: 39:160/303.0                                                  *
  18. *                                                                          *
  19. *                                                                          *
  20. *  Support BBS:  UTILITYBASE  +46-322-17877 16.8kHST+V32"   2:203/316.0    *
  21. *                                                                          *
  22. ****************************************************************************
  23. $VER: FusTick 2.8 (94-Mar-13) © by Robert Wahlström 1994
  24.  
  25.  
  26. 1. INTRODUCTION
  27. ===============
  28.  
  29. WHAT IS FusTick?
  30.  
  31. FusTick is a utility that handles file echo .tic files.
  32. At the moment FusTick works with MEBBSNet and as a stand alone program. 
  33.  
  34.  
  35. 2. LICENSE
  36. ==========
  37.  
  38. This material is © Copyright 1994 by Robert Wahlström -- All rights reserved.
  39.  
  40. It may be distributed freely as long as the following restrictions are met:
  41.  
  42. The distributor may charge a fee to recover distribution costs. The fee for
  43. diskette distribution should not be more than the cost to obtain the same
  44. diskette from Fred Fish.
  45.  
  46. The distributor agrees to cease distributing the programs and data involved
  47. if requested to do so by the authors.
  48.  
  49. You may copy and distribute verbatim copies of the program's executable code
  50. and documentation as you receive it, in any medium, provided that you
  51. conspicuously and appropriately publish only the original, unmodified program,
  52. with all copyright notices and disclaimers of warranty intact and including
  53. all the accompanying documentation, example files and anything else that came
  54. with the original.                                         
  55.  
  56. The author will not be liable for any damage arising from the failure of this
  57. program to perform as described, or any destruction of other programs or data
  58. residing on a system attempting to run the program. While I know of no 
  59. damaging errors, the user of this program uses it at his or her own risk. 
  60.  
  61.  
  62.  
  63. 3 REQUIREMENTS
  64. ==============
  65.  
  66. AmigaDos 2.0 or higher.
  67. Mebbsnet 0.158
  68.  
  69.  
  70. 4 INSTALLATION
  71. ==============
  72.  
  73. Put FusTick anywhere. (Ex in directory MebbsNet:c)
  74.  
  75. FUSTick NEEDS a configutation file called TICK.CFG this file can
  76. be placed in the directory from where FUSTick is started.
  77.  
  78. If an Env variable is set FUSTick gets the configuration file name from 
  79. the ENV variable.
  80.  
  81. EX: setenv FusTick MebbsNet:ConfigFiles/tick.cfg   
  82.     Fustick gets Tick.cfg from MebbsNet:ConfigFiles/tick.cfg
  83.  
  84. If FusTick is started with the argument  CONFIGFILE=<configfil> 
  85. The argument filename will be used INSTEAD of the ENV variable namne.
  86.  
  87. Fustick also handles a datafile to be used from other FUS utilities like the
  88. TickStat (Fileecho statistics utility)
  89.  
  90.  
  91. Example configuration file:
  92.  
  93.  
  94. 5 CONFIGFILE
  95. ============
  96.  
  97. HERE <Address>                   
  98. [AKA  <Address> [Address] ... ]
  99. PASSWORD <Address> <Password>
  100. [EMAILAREA] <areanumber>
  101. [CHECK_CRC]
  102. [IN <Inbound Path>]
  103. [OUT <Outbound Path>]
  104. [BAD <Bad Files Path>]
  105. [COPYTIC <copy tic path>]
  106. [LOGFILE <Path/Name for log>] 
  107. [LOGLEVEL <level>]
  108. [LIST <TagPattern> <ListName> [<OutputFormat>]]
  109. [HOLD <node>] 
  110. [MEBBS]       - Signals FUSTICK that you are using MEBBS and without this line 
  111.                 FUSTICK can't add files to the MebbsNet file areas. 
  112.  
  113. [UTC <offset i min>]
  114. [DEFAULTAREA <name>] 
  115.  
  116.  
  117. ; FileEcho block. ONE block for each file echo AREA
  118. FILEECHO <AreaTag> <Directory>
  119. [FILEAREA <AreaName>]
  120. [MAKEFREE]
  121. [NOHATCH]
  122. TO [<address> <address> <address>... ]
  123.  
  124.  
  125.        Items in square brackets "[]" are optional, depending upon the
  126.     environment.  See breakdown below.  Items in "greater than" and
  127.     "less than" symbols "<>" are not literal, but should be replaced by
  128.     appropriate data.  Lines are >NOT< case sensitive, and may be
  129.     preceded or followed by whitespace.  Blank lines and sections of
  130.     lines following a semicolon ";"    will be treated as comments and
  131.     ignored.
  132.  
  133.     HERE <Z:Net/Node.[point]>
  134.     -------------------------
  135.  
  136.     The  "HERE"  parameter  tells  FusTick  what  your  system's FidoNet
  137.     address is. This must be your 3 or 4 dimensional address.
  138.  
  139.     ex: HERE 2:203/316
  140.         HERE 2:203/316.5
  141.  
  142.     [AKA  <Address> [Address] ... ]
  143.     -------------------------------
  144.  
  145.     If your system is using AKA addresses enter them here like:
  146.     
  147.     ex: AKA 39:160/105
  148.  
  149.     PASSWORD <Z:Net/Node[.point]> <Password>
  150.     ----------------------------------------
  151.  
  152.     All system that you send/recive files from MUST be listed in the
  153.     password list.If FUSTICK fails to find a node or correct password.
  154.     The file and the tic file will go to a BAD directory.
  155.  
  156.     ex:
  157.        PASSWORD 2:203/316 UtilityBase
  158.        PASSWORD 2:203/129
  159.        PASSWORD 2:203/316.5 dfhg 
  160.  
  161.     EMAILAREA <Area number>
  162.     -----------------------
  163.  
  164.        The number of your email area.
  165.  
  166.        Default 1
  167.  
  168.  
  169.     CHECK_CRC
  170.     ---------
  171.       
  172.  
  173.        Having this line in your Tic.cfg file is a good ide since it
  174.        checks if the file is corrupt in some way and no one likes to
  175.        get bad files via a file echo.
  176.      
  177.  
  178.     IN <Inbound Path>
  179.     -----------------
  180.  
  181.          Your inbound directory. The default is "MebbsNet:in/".
  182.  
  183.     ex:
  184.         IN MAIL:inbound/
  185.  
  186.  
  187.     OUT <Outbound Path>
  188.     -------------------
  189.  
  190.          Your outbound directory. The default is "Mebbsnet:out/".
  191.  
  192.     ex:
  193.         OUT MAIL:outbound/
  194.  
  195.  
  196.     BAD <Bad Files Path> 
  197.     --------------------
  198.  
  199.         The directory where all bad files (unknown area, failed CRC check,
  200.         from unknown system, Tick files without the appropriate file) are
  201.         moved to. The default is "MebbsNet:bad/".
  202.  
  203.     ex:
  204.         BAD MAIL:BAD/
  205.  
  206.     COPYTIC <copy tic path>
  207.     -----------------------
  208.  
  209.         Backup directory for all incoming ticfiles.
  210.         
  211.         Default: No backup  
  212.  
  213.     ex: 
  214.         COPYTIC back:tic/
  215.         
  216.  
  217.     LOGFILE <logfil>
  218.     ----------------
  219.  
  220.         Name and path to logfile. 
  221.  
  222.         Recommended: Assign a directory to hold the LOGfiles.
  223.         like: 
  224.         Assign LOG: Mail:log (wish this could be a standard log dir) :-)
  225.         (We DONT want them in MebbsNet: its full of stuff anyway)
  226.  
  227.     ex:
  228.         LOG:FUSTick.log
  229.  
  230.  
  231.     LOGLEVEL <level>
  232.     ----------------
  233.  
  234.         Loglevel value  1-9. Higher value - more logging
  235.         level 3 is default
  236.     
  237.     ex LOGLEVEL 5
  238.  
  239.  
  240.     HOLD <Z:Net/Node[.point]>  
  241.     -------------------------
  242.      
  243.        This indicates that the .flo files should be HELD until the 
  244.        reciving node calls you. (The .FLO is changed to .HLO file.)
  245.           
  246.        Note that this option ONLY works with 4 dimentional addresses
  247.        (read Trapdoor or other external mailer)
  248.                 
  249.  ex:   HOLD 2:203/129.0
  250.        HOLD 2:203/316.5
  251.  
  252.  
  253.      LIST <TagPattern> <ListPath/Name> <OutputFormat>
  254.      ------------------------------------------------
  255.  
  256.        This line  is  used to generate a listing of the files processed
  257.        by  FusTick.  There may be any number of these lines, limited by
  258.        memory  of  course,  and  they  may  each  act  upon any number of
  259.        echos.  Below is an explanation of each field:
  260.  
  261.      <TagPattern>
  262.          This is  a  simple  pattern match, which indicates which echos
  263.        are  to  be considered for listing in this listfile.  It accepts
  264.        the MS-DOS type "?" and "*" , and Amiga-DOS wildcard characters.
  265.  
  266.      <ListPath/Name>
  267.        This  is the path and name of the file FusTick should make the
  268.        file list in.
  269.  
  270.      <OutputFormat>
  271.  
  272.        This  is the format FusTick should use when adding to the list
  273.        file.   It  is  a  very  powerful way to specify the look of the
  274.        list.   Those who know C will recognize the syntax of the format
  275.        specifier,   those   who   don't   may  have  a  little  trouble
  276.        understanding   it.    All  text  is  copied  exact  except  for
  277.        sequences  starting  with  a  percent  "%" symbol.  They work as
  278.        follows:
  279.  
  280.        %[-][<w>]<t>
  281.  
  282.        Where:
  283.          %
  284.                  is  the  escape  to  a  sequence  - must prefix all of
  285.                  them.
  286.          [-]
  287.                  is an optional dash meaning "Left justify this field"
  288.          [<w>]
  289.                  is  the  optional (fixed) width of the field.  Replace
  290.                  this  with  the appropriate number if you wish to make
  291.                  your  listing  in columns, otherwise the field will be
  292.                  of  variable  length.   If field is numeric (i.e. CRC,
  293.                  length)  a  leading  0  may  be  specified  to pad the
  294.                  leading end of the number with 0's.
  295.          <t>     is the type of field.  There are 7 types supported:
  296.                  a   areaname
  297.                  c   crc             Form: Hex digits
  298.                  d   description
  299.                  l   length          Form: Decimal digits (in bytes)
  300.                  n   filename
  301.                  o   origin address  Form: (Z:Net/Node)
  302.  
  303.  
  304.       Examples:
  305.  
  306.        LIST  SKY*  ADSFILES.LST  Area:  %a\nName: %n\nLength: %l\nDesc:
  307.        %d\nOrigin: %o\nCRC: %c\n
  308.  
  309.        LIST NODE* FIDOFILE.LST %-12a | %-14n - %d\n
  310.  
  311.      The first would result possibly in this listing being generated:
  312.  
  313.        Area: SKYUTILS
  314.        Name: CH136_E.LHA
  315.        Length: 44060
  316.        Desc: Chelp 1.36 [eval] - Search in autodocs & includes
  317.        Origin: 1:150/111
  318.        CRC: 6623414
  319.                                                                                         
  320.      While the second would result in something like this:
  321.  
  322.        NODEDIFF     | NODEDIFF.A45   - FidoNet NodeDiff for day 145
  323.        NODEDIFF     | NODEDIFF.A59   - FidoNet NodeDiff for day 159
  324.  
  325.      '\n' is replaced by a newline character when printed.
  326.      A '\n' must be placed at the end of the line.
  327.  
  328.      It is fine to have multiple LIST lines pointing to the same file,
  329.      as long  as the tag patterns are mutually exclusive (or duplicate
  330.      listing will occur).
  331.  
  332.      If no output format is specified, the following is default:
  333.      %-16a | %-13n | %7l | %d\n
  334.  
  335.  
  336.     MEBBS     
  337.     -------
  338.  
  339.      Notifies that MebbsNet is the BBS program you are using
  340.      Without this comand FUSTICK cant send files to the MEBBSNET file areas.
  341.  
  342.  
  343.     UTC [offset] 
  344.     ------------
  345.  
  346.         The offset value specifies the time in minutes to calculate the
  347.         UTC from your local time. This value is added to your local time
  348.         before FusTick inserts any date-/time-strings into  the path-lines 
  349.         of a .tic file.
  350.  
  351.         Sweden -60 (summertime(GMT))  -60 (wintertime(CET))
  352.         UK  0
  353.  
  354.     ex: UTC -60
  355.   
  356.  
  357.     DEFAULTAREA [namn]
  358.     ------------------
  359.  
  360.         Tells FUSTICK what default area to use when hatching files.
  361.  
  362.         ex: DAEFAULTAREA SKYPROG
  363.  
  364.     FileEchoblock
  365.     =============
  366.  
  367.     FILEECHO <AreaTag> <Path>
  368.     -------------------------
  369.  
  370.     Indicates the start of an 'Area Block' all lines below this line 
  371.     has to do with ONE fileecho area.
  372.     
  373.     All paths MUST end with an / or :
  374.  
  375.     ex:
  376.         FILEECHO ADSMEBBS DIV:files/mebbs/
  377.  
  378.     <Path> MUST be present if you dont want to add the incomming files
  379.     wiht its descriptions to the MEBBSnet Fileareas.This might be convienient
  380.     if you want to add the file to another directory.
  381.  
  382.     If the FILEAREA command is present with the area actuall Areaname
  383.     the file will be added to MEBBSnet fileare listings and the physical file
  384.     will be copied to the appropriate directory.
  385.  
  386.  
  387.     FILEAREA <Area name>
  388.     --------------------
  389.  
  390.     The actual name in your BBS for the file area where you want your
  391.     incomming files.
  392.     
  393.     ex:
  394.         FILEECHO ADSMEBBS
  395.         FILEAREA Mebbs Utilities 
  396.         TO 2:203/424.0
  397.         TO 2:203/319.0
  398.  
  399.  
  400.     MAKEFREE
  401.     --------
  402.  
  403.         Enter this if you want the areas incomming files to be Free download.
  404.  
  405.     NOHATCH
  406.     -------
  407.  
  408.         If you don't want to hatch files in this area.
  409.     
  410.         ex:
  411.             FILEECHO  NODEDIFF mail:nodelist/
  412.             NOHATCH ; Don't hatch in nodediff
  413.             TO 2:203/316.5
  414.  
  415.  
  416.  
  417.     TO <Z:Net/Node.[point]> <Z:Net/Node.[point]> <Z:Net/Node.[point]>...
  418.     --------------------------------------------------------------------
  419.  
  420.        ex:
  421.  
  422.     TO 2:204/641.0 2:204/455.0 
  423.  
  424.        Tells Fus tick who to send recived files to
  425.        Note that if your BBS is the last in the chain and you are NOT
  426.        sending it to anyone else just enter a blank TO statement in those areas.
  427.  
  428.  
  429.     ex: 
  430.  
  431.         FILEECHO  NODEDIFF mail:nodelist/                                                       
  432.         TO                                                                                      
  433.                                                                                         
  434.         FILEECHO  NEWSTARTICK  work:lc/prg/snet/newstartic/fil/                                 
  435.         FILEAREA Utilities
  436.         TO 2:203/300                                                                            
  437.                                                                                         
  438.         FILEECHO  SKYUTILS work:bbs/fl/utils/                                                   
  439.         MAKEFREE
  440.         FILEAREA Graphics                                                                      
  441.         TO 2:203/129                                                                          
  442.         TO 2:203/600 2:203/235.5                                                                  
  443.  
  444.  
  445.     
  446.  
  447. 6 Running FusTick
  448. =================
  449.  
  450.  
  451.     FUSTick arguments:
  452.  
  453.         FUSTick [HATCH] [CONFIGFILE=<configfile>] [PUBSCREEN=<pubscreenname>]
  454.                 [LIST] [QUERY=<nodenuber>]
  455.  
  456.     CONFIGFILE -  Tells FUSTICK to use another configuration file the the 
  457.                   default one (Tick.cfg) OR the file specifyed with the ENV
  458.                   command.
  459.  
  460.                   ex:
  461.                      FusTick  CONFIGFILE=work:special_tick.cfg
  462.  
  463.     HATCH      -  Puts FUSTICK into HATCH mode and open hatchwindow.
  464.  
  465.     PUBSCREEN  -  Open Hatchwindow on a publicscreen
  466.  
  467.                   ex:
  468.                      FusTick HATCH PUBSCREEN=DOPUS.1
  469.  
  470.    QUERY       - List all active areas for node [nodenumber]
  471.  
  472.                   ex:
  473.                      FusTick QUERY=2:203/316    
  474.                         
  475.    LIST        - List all availible areas
  476.  
  477.                   ex:
  478.                      FusTick LIST
  479.  
  480.  
  481. 7  The HATCHING of FILES
  482. =========================
  483.  
  484.  
  485.     FusTick  HATCH
  486.         Opens a window that is used to hatch files in to an file echo.
  487.         The "square" at the right are used to select the filearea to hatch
  488.         the file in.
  489.     
  490.  
  491.     FILE Field:
  492.         Are used to select the file to hatch.
  493.         You could also use a regular file requester to select file to hatch        
  494.         with the TINY gadget at the window.
  495.         
  496.         enter something like: Work:prog/FUSTick_101.lha
  497.  
  498.     AS field:
  499.         
  500.         Tells Fustick under what name the file should be sent.
  501.  
  502.         ex: FST101.lha
  503.  
  504.     DESC field: 
  505.         
  506.         Where to enter the file description.
  507.  
  508.         ex:  FusTick 2.7 Nice tick utility for MEBBS.
  509.  
  510.     TO FILAREA gadget: 
  511.         
  512.         Used if you want the file sent to your own BBS fileareas.        
  513.     
  514.     CYCLE gadget:
  515.         Selects type of outgoing file HOLD, NORMAL or CRASH
  516.  
  517.     HATCH:  
  518.         When everything is set this one is selected to actual HATCH the file
  519.  
  520.  
  521. 8 TickStat
  522. ==========
  523.  
  524. Tickstat is a small utility that monitors the amount of incomming fileecho
  525. files.
  526.  
  527. TickStat [-f<statdatafil>]
  528.  
  529. Tickstat                    Tries to get the information from tick.log.dat 
  530.  
  531. Tickstat -f<datafil>       Uses the dat file from the one entered.
  532.                            ex:
  533.                                TickStat -flog:Tick.log.dat
  534.  
  535.  
  536. ex of running tickstat:
  537.  
  538. TickStat 0.04 © 1992 Robert Wahlstrom
  539.  
  540. Area                 Today    Week   Month    Year   Total
  541. ==========================================================
  542. ADSFIDO                  7       7       7       7       7
  543. SKYTEXT                  3       3       3       3       3
  544. SKYCOMMS                 0      50      50      50      50
  545. NODEDIFF                 0      59      59      59      59
  546. SKYPROGS                 0     104     104     104     104
  547. SKYUTILS               145     393     393     393     393
  548. FUS_FILES                0     171     171     171     171
  549. ADSWORK2                 0      78      78      78      78
  550. Total:                 156     868     868     868     868
  551.  
  552.  
  553.  
  554.  
  555. 9. ADDRESSES AND PHONENUMBERS
  556. =============================
  557.  
  558. If You have any questions, suggestions or bug-reports, please contact us.
  559. NetMail, snailmail, voice or logging on to our support bbs's.
  560. Here are addresses and phonenumbers:
  561.  
  562.  
  563. Robert Wahlstrom
  564. Enehagsg 197
  565. S-441 57 ALINGSÅS
  566. SWEDEN
  567. phone: +46 (0)322-183 31
  568.  
  569. Support BBS:
  570.  
  571. UtilityBase  +46 (0)322-178 77   v32" + 16.8k HST
  572. Fido: 2:203/316.0  Amiganet: 39:160/303.0
  573. Usenet: d0robert@dtek.chalmers.se
  574.  
  575.  
  576. MEBBSnet Service Center (SWEDEN):
  577. Yggdrazil bbs   +46 (0)11-164276 Line 1
  578.                 +46 (0)11-107033 Line 2
  579.                 +46 (0)11-107037 Line 3
  580.                 +46 (0)11-107069 Line 4
  581.  
  582. Fido: 2:204/455.0
  583.  
  584. 10. CREDITS
  585. ===========
  586. Thanks to the following for hints, suggestions and debugging:
  587.  
  588. Kejll Harnesk           - alfatesting, many ideas.
  589. Kjell Cederfeldt        - alfatesting, many ideas.
  590. Mikael Johansson        - alfatesting
  591. Stefan von Straten      - MEBBS support Sweden, Documentation. 
  592. William Bowling         - MEBBS
  593.  
  594.  
  595. 11 Other programs by Robert Wahlström
  596. =====================================
  597.  
  598. FusEdit - Fullscreeneditor for MEBBS
  599. FusAC   - Areafix for MEBBS
  600. FusList - Very configurable filearea list creator
  601.  
  602. Chelp   - A help program for programmers - Lookup functions in autodocs
  603.           and strcuts/defines in includefiles
  604. Ast     - Astronomyprogram (beta only)
  605.  
  606.